Add relative_path built-in function#3185
Open
hunter-hongg wants to merge 1 commit intocasey:masterfrom
Open
Conversation
Adds a new built-in function `relative_path` that computes a relative path from one path to another using `Path::strip_prefix`. This provides an OS-agnostic alternative to the `relpath` bash utility, which breaks on macOS where bash runs as zsh. The function handles both absolute and relative paths across all supported platforms.
casey
requested changes
Mar 30, 2026
| } | ||
|
|
||
| fn relpath(_context: Context, target: &str, base: &str) -> FunctionResult { | ||
| let base = match Utf8Path::new(base).canonicalize(){ |
Owner
There was a problem hiding this comment.
I'm not a fan of canonicalize unless necessary. I would join them both to the current working directory, lexiclean them, and then compute the relative path.
| Ok(t) => t, | ||
| Err(e) => return Err(format!("Canonicalize path {target} failed: {e}")), | ||
| }; | ||
| if let Some(rel) = pathdiff::diff_paths(&target, &base) { |
Owner
There was a problem hiding this comment.
I would prefer not to add a dependency for a single simple function.
| if let Some(rel) = pathdiff::diff_paths(&target, &base) { | ||
| Ok(rel.display().to_string()) | ||
| } else { | ||
| Ok(target.display().to_string()) // fallback to absolute path |
Owner
There was a problem hiding this comment.
It's not clear to me that it's useful to fall back to an absolute path. Is this desirable? Would an error be better?
| /test-utilities/Cargo.lock | ||
| /test-utilities/target | ||
| /tmp | ||
| /3104issue.json |
| lexiclean = "0.0.1" | ||
| libc = "0.2.0" | ||
| num_cpus = "1.15.0" | ||
| pathdiff = "0.2.3" |
Owner
There was a problem hiding this comment.
Suggested change
| pathdiff = "0.2.3" |
I'd rather not add a dependency for a single function, it should just be implemented in this PR.
Owner
|
Also, I couldn't find which |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a new built-in function
relative_paththat computes a relative path from one path to another usingPath::strip_prefix. This provides an OS-agnostic alternative to therelpathbash utility, which breaks on macOS.